System.Gadget.Flyout.file property

[The Windows Gadget Platform/Sidebar is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. ]

Gets or sets the HTML filename for the gadget Flyout UI.

This property is read/write.

Syntax

strfile = System.Gadget.Flyout.file
System.Gadget.Flyout.file = strfile

Property value

A String that specifies or receives the HTML filename.

Remarks

A gadget Flyout is shown with a call to show.

A gadget has one Flyout available at any time. The content of the Flyout can modified dynamically using the document object or by specifying a new HTML file with the file property.

Examples

The following example demonstrates how to set the gadget Flyout UI from the gadget script file.

// --------------------------------------------------------------------
// Initialize the gadget.
// --------------------------------------------------------------------
function Init()
{
    // Specify the flyout root.
    System.Gadget.Flyout.file = "example.html";
    
    // Initialize the Flyout state display.
    if (!System.Gadget.Flyout.show)
    {
        sFlyoutFeedback.innerText = "Flyout hidden.";
    }
}

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
End of client support
Windows 7
End of server support
Windows Server 2008
IDL
Sidebar.idl
DLL
Sidebar.Exe (version 1.00 or later)